Skip to content

docs: fix unclosed info admonition in authorizing-the-slack-cli#604

Merged
mwbrooks merged 1 commit into
mainfrom
docs-fix-skip-update-admonition
Jun 30, 2026
Merged

docs: fix unclosed info admonition in authorizing-the-slack-cli#604
mwbrooks merged 1 commit into
mainfrom
docs-fix-skip-update-admonition

Conversation

@zimeg

@zimeg zimeg commented Jun 30, 2026

Copy link
Copy Markdown
Member

Changelog

Fixed a malformed :::info admonition on the Authorizing the Slack CLI guide that was breaking page rendering.

Summary

This pull request fixes an unclosed :::info admonition in the Authorizing the Slack CLI guide.

  • The admonition about --skip-update / SLACK_SKIP_UPDATE being ignored by slack upgrade was missing the closing ] on its title.
  • The unclosed title bracket caused the MDX renderer to mangle later content, surfacing a stray authorize-cli} in the rendered page.
  • Adding the missing ] closes the title and restores correct rendering.

Preview

https://docs.slack.dev/tools/slack-cli/guides/authorizing-the-slack-cli/#version-updates

Testing

  • Open the guide above and scroll to the Version update notifications section.
  • Confirm the info admonition about slack upgrade ignoring --skip-update / SLACK_SKIP_UPDATE renders as a normal callout box.
  • Confirm no stray authorize-cli} text appears near the top of the page.

Notes

Source file: docs/guides/authorizing-the-slack-cli.md. One-character fix (adds the closing ]).

Requirements

The `:::info` block about `--skip-update` / `SLACK_SKIP_UPDATE` being
ignored by `slack upgrade` was missing the closing `]` on its title.
The unclosed title bracket caused the MDX renderer to mangle later
content on the page, surfacing a stray `authorize-cli}` in the preview.

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@zimeg zimeg added this to the Next Release milestone Jun 30, 2026
@zimeg zimeg added bug M-T: confirmed bug report. Issues are confirmed when the reproduction steps are documented docs M-T: Documentation work only labels Jun 30, 2026
@zimeg zimeg self-assigned this Jun 30, 2026
@codecov

codecov Bot commented Jun 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.67%. Comparing base (44ce627) to head (84ac9eb).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #604      +/-   ##
==========================================
- Coverage   71.68%   71.67%   -0.02%     
==========================================
  Files         226      226              
  Lines       19176    19176              
==========================================
- Hits        13747    13744       -3     
- Misses       4220     4221       +1     
- Partials     1209     1211       +2     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@zimeg zimeg marked this pull request as ready for review June 30, 2026 22:59
@zimeg zimeg requested a review from a team as a code owner June 30, 2026 22:59
When the CLI runs in a non-interactive environment, such as inside a CI/CD pipeline or when the output is piped, the update check runs without the auto-update confirmation prompt. The notification text may still appear in command output, however. You can suppress the check entirely with the `--skip-update` flag or `SLACK_SKIP_UPDATE` environment variable to keep the automation output clean.

:::info[The `--skip-update` flag and the `SLACK_SKIP_UPDATE` environment variable are intentionally ignored when running the `slack upgrade` command directly, since that command's purpose is to check for updates.
:::info[The `--skip-update` flag and the `SLACK_SKIP_UPDATE` environment variable are intentionally ignored when running the `slack upgrade` command directly, since that command's purpose is to check for updates.]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, great eye. I had to look twice before seeing the addition! +++

@mwbrooks

Copy link
Copy Markdown
Member

Thanks for the fix up @zimeg! I'll merge this now so we don't lose track of it! 🙇🏻

@mwbrooks mwbrooks merged commit 4565149 into main Jun 30, 2026
10 checks passed
@mwbrooks mwbrooks deleted the docs-fix-skip-update-admonition branch June 30, 2026 23:12
@zimeg

zimeg commented Jun 30, 2026

Copy link
Copy Markdown
Member Author

@mwbrooks Immense thanks once again! The "auto" merge feature is awkward for me with also so much changes scattered about... Let's keep up the momentum! 🚢 💨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug M-T: confirmed bug report. Issues are confirmed when the reproduction steps are documented docs M-T: Documentation work only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants